home *** CD-ROM | disk | FTP | other *** search
/ Games of Daze / Infomagic - Games of Daze (Summer 1995) (Disc 1 of 2).iso / djgpp / src / binutils.252 / include / bfdlink.h < prev    next >
Encoding:
C/C++ Source or Header  |  1994-10-27  |  16.6 KB  |  422 lines
  1. /* bfdlink.h -- header file for BFD link routines
  2.    Copyright 1993 Free Software Foundation, Inc.
  3.    Written by Steve Chamberlain and Ian Lance Taylor, Cygnus Support.
  4.  
  5. This file is part of BFD, the Binary File Descriptor library.
  6.  
  7. This program is free software; you can redistribute it and/or modify
  8. it under the terms of the GNU General Public License as published by
  9. the Free Software Foundation; either version 2 of the License, or
  10. (at your option) any later version.
  11.  
  12. This program is distributed in the hope that it will be useful,
  13. but WITHOUT ANY WARRANTY; without even the implied warranty of
  14. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15. GNU General Public License for more details.
  16.  
  17. You should have received a copy of the GNU General Public License
  18. along with this program; if not, write to the Free Software
  19. Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.  */
  20.  
  21. #ifndef BFDLINK_H
  22. #define BFDLINK_H
  23.  
  24. /* Which symbols to strip during a link.  */
  25. enum bfd_link_strip
  26. {
  27.   strip_none,        /* Don't strip any symbols.  */
  28.   strip_debugger,    /* Strip debugging symbols.  */
  29.   strip_some,        /* keep_hash is the list of symbols to keep.  */
  30.   strip_all        /* Strip all symbols.  */
  31. };
  32.  
  33. /* Which local symbols to discard during a link.  This is irrelevant
  34.    if strip_all is used.  */
  35. enum bfd_link_discard
  36. {
  37.   discard_none,        /* Don't discard any locals.  */
  38.   discard_l,        /* Discard locals with a certain prefix.  */
  39.   discard_all        /* Discard all locals.  */
  40. };
  41.  
  42. /* These are the possible types of an entry in the BFD link hash
  43.    table.  */
  44.  
  45. enum bfd_link_hash_type
  46. {
  47.   bfd_link_hash_new,        /* Symbol is new.  */
  48.   bfd_link_hash_undefined,    /* Symbol seen before, but undefined.  */
  49.   bfd_link_hash_weak,        /* Symbol is weak and undefined.  */
  50.   bfd_link_hash_defined,    /* Symbol is defined.  */
  51.   bfd_link_hash_common,        /* Symbol is common.  */
  52.   bfd_link_hash_indirect,    /* Symbol is an indirect link.  */
  53.   bfd_link_hash_warning        /* Like indirect, but warn if referenced.  */
  54. };
  55.  
  56. /* The linking routines use a hash table which uses this structure for
  57.    its elements.  */
  58.  
  59. struct bfd_link_hash_entry
  60. {
  61.   /* Base hash table entry structure.  */
  62.   struct bfd_hash_entry root;
  63.   /* Type of this entry.  */
  64.   enum bfd_link_hash_type type;
  65.  
  66.   /* Undefined and common symbols are kept in a linked list through
  67.      this field.  This field is not in the union because that would
  68.      force us to remove entries from the list when we changed their
  69.      type, which would force the list to be doubly linked, which would
  70.      waste more memory.  When an undefined or common symbol is
  71.      created, it should be added to this list, the head of which is in
  72.      the link hash table itself.  As symbols are defined, they need
  73.      not be removed from the list; anything which reads the list must
  74.      doublecheck the symbol type.
  75.  
  76.      Weak symbols are not kept on this list.
  77.  
  78.      Defined symbols use this field as a reference marker.  If the
  79.      field is not NULL, or this structure is the tail of the undefined
  80.      symbol list, the symbol has been referenced.  If the symbol is
  81.      undefined and becomes defined, this field will automatically be
  82.      non-NULL since the symbol will have been on the undefined symbol
  83.      list.  */
  84.   struct bfd_link_hash_entry *next;
  85.   /* A union of information depending upon the type.  */
  86.   union
  87.     {
  88.       /* Nothing is kept for bfd_hash_new.  */
  89.       /* bfd_link_hash_undefined, bfd_link_hash_weak.  */
  90.       struct
  91.     {
  92.       bfd *abfd;        /* BFD symbol was found in.  */
  93.     } undef;
  94.       /* bfd_link_hash_defined.  */
  95.       struct
  96.     {
  97.       bfd_vma value;    /* Symbol value.  */
  98.       asection *section;    /* Symbol section.  */
  99.     } def;
  100.       /* bfd_link_hash_indirect, bfd_link_hash_warning.  */
  101.       struct
  102.     {
  103.       struct bfd_link_hash_entry *link;    /* Real symbol.  */
  104.       const char *warning;    /* Warning (bfd_link_hash_warning only).  */
  105.     } i;
  106.       /* bfd_link_hash_common.  */
  107.       struct
  108.     {
  109.       /* The linker needs to know three things about common
  110.              symbols: the size, the alignment, and the section in
  111.              which the symbol should be placed.  On the assumption
  112.              that a single common symbol will not take up incredible
  113.              amounts of memory, we pack the size and the alignment
  114.              into the space of a single integer.  The alignment is
  115.              stored as a power of two.  */
  116.       unsigned int alignment_power : 8;    /* Alignment.  */
  117.       unsigned int size : 24;        /* Common symbol size.  */
  118.       asection *section;            /* Symbol section.  */
  119.     } c;
  120.     } u;
  121. };
  122.  
  123. /* This is the link hash table.  It is a derived class of
  124.    bfd_hash_table.  */
  125.  
  126. struct bfd_link_hash_table
  127. {
  128.   /* The hash table itself.  */
  129.   struct bfd_hash_table table;
  130.   /* The back end which created this hash table.  This indicates the
  131.      type of the entries in the hash table, which is sometimes
  132.      important information when linking object files of different
  133.      types together.  */
  134.   const bfd_target *creator;
  135.   /* A linked list of undefined and common symbols, linked through the
  136.      next field in the bfd_link_hash_entry structure.  */
  137.   struct bfd_link_hash_entry *undefs;
  138.   /* Entries are added to the tail of the undefs list.  */
  139.   struct bfd_link_hash_entry *undefs_tail;
  140. };
  141.  
  142. /* Look up an entry in a link hash table.  If FOLLOW is true, this
  143.    follows bfd_link_hash_indirect and bfd_link_hash_warning links to
  144.    the real symbol.  */
  145. extern struct bfd_link_hash_entry *bfd_link_hash_lookup
  146.   PARAMS ((struct bfd_link_hash_table *, const char *, boolean create,
  147.        boolean copy, boolean follow));
  148.  
  149. /* Traverse a link hash table.  */
  150. extern void bfd_link_hash_traverse
  151.   PARAMS ((struct bfd_link_hash_table *,
  152.        boolean (*) (struct bfd_link_hash_entry *, PTR),
  153.        PTR));
  154.  
  155. /* Add an entry to the undefs list.  */
  156. extern void bfd_link_add_undef
  157.   PARAMS ((struct bfd_link_hash_table *, struct bfd_link_hash_entry *));
  158.  
  159. /* This structure holds all the information needed to communicate
  160.    between BFD and the linker when doing a link.  */
  161.  
  162. struct bfd_link_info
  163. {
  164.   /* Function callbacks.  */
  165.   const struct bfd_link_callbacks *callbacks;
  166.   /* true if BFD should generate a relocateable object file.  */
  167.   boolean relocateable;
  168.   /* true if BFD should generate a shared object.  */
  169.   boolean shared;
  170.   /* Which symbols to strip.  */
  171.   enum bfd_link_strip strip;
  172.   /* Which local symbols to discard.  */
  173.   enum bfd_link_discard discard;
  174.   /* The local symbol prefix to discard if using discard_l.  */
  175.   unsigned int lprefix_len;
  176.   const char *lprefix;
  177.   /* true if symbols should be retained in memory, false if they
  178.      should be freed and reread.  */
  179.   boolean keep_memory;
  180.   /* The list of input BFD's involved in the link.  These are chained
  181.      together via the link_next field.  */
  182.   bfd *input_bfds;
  183.   /* If a symbol should be created for each input BFD, this is section
  184.      where those symbols should be placed.  It must be a section in
  185.      the output BFD.  It may be NULL, in which case no such symbols
  186.      will be created.  This is to support CREATE_OBJECT_SYMBOLS in the
  187.      linker command language.  */
  188.   asection *create_object_symbols_section;
  189.   /* Hash table handled by BFD.  */
  190.   struct bfd_link_hash_table *hash;
  191.   /* Hash table of symbols to keep.  This is NULL unless strip is
  192.      strip_some.  */
  193.   struct bfd_hash_table *keep_hash;
  194.   /* Hash table of symbols to report back via notice_callback.  If
  195.      this is NULL no symbols are reported back.  */
  196.   struct bfd_hash_table *notice_hash;
  197. };
  198.  
  199. /* This structures holds a set of callback functions.  These are
  200.    called by the BFD linker routines.  The first argument to each
  201.    callback function is the bfd_link_info structure being used.  Each
  202.    function returns a boolean value.  If the function returns false,
  203.    then the BFD function which called it will return with a failure
  204.    indication.  */
  205.  
  206. struct bfd_link_callbacks
  207. {
  208.   /* A function which is called when an object is added from an
  209.      archive.  ABFD is the archive element being added.  NAME is the
  210.      name of the symbol which caused the archive element to be pulled
  211.      in.  */
  212.   boolean (*add_archive_element) PARAMS ((struct bfd_link_info *,
  213.                       bfd *abfd,
  214.                       const char *name));
  215.   /* A function which is called when a symbol is found with multiple
  216.      definitions.  NAME is the symbol which is defined multiple times.
  217.      OBFD is the old BFD, OSEC is the old section, OVAL is the old
  218.      value, NBFD is the new BFD, NSEC is the new section, and NVAL is
  219.      the new value.  OBFD may be NULL.  OSEC and NSEC may be
  220.      bfd_com_section or bfd_ind_section.  */
  221.   boolean (*multiple_definition) PARAMS ((struct bfd_link_info *,
  222.                       const char *name,
  223.                       bfd *obfd,
  224.                       asection *osec,
  225.                       bfd_vma oval,
  226.                       bfd *nbfd,
  227.                       asection *nsec,
  228.                       bfd_vma nval));
  229.   /* A function which is called when a common symbol is defined
  230.      multiple times.  NAME is the symbol appearing multiple times.
  231.      OBFD is the BFD of the existing symbol; it may be NULL if this is
  232.      not known.  OTYPE is the type of the existing symbol, which may
  233.      be bfd_link_hash_defined, bfd_link_hash_common, or
  234.      bfd_link_hash_indirect.  If OTYPE is bfd_link_hash_common, OSIZE
  235.      is the size of the existing symbol.  NBFD is the BFD of the new
  236.      symbol.  NTYPE is the type of the new symbol, again one of
  237.      bfd_link_hash_defined, bfd_link_hash_common, or
  238.      bfd_link_hash_indirect.  If NTYPE is bfd_link_hash_common, NSIZE
  239.      is the size of the new symbol.  */
  240.   boolean (*multiple_common) PARAMS ((struct bfd_link_info *,
  241.                       const char *name,
  242.                       bfd *obfd,
  243.                       enum bfd_link_hash_type otype,
  244.                       bfd_vma osize,
  245.                       bfd *nbfd,
  246.                       enum bfd_link_hash_type ntype,
  247.                       bfd_vma nsize));
  248.   /* A function which is called to add a symbol to a set.  ENTRY is
  249.      the link hash table entry for the set itself (e.g.,
  250.      __CTOR_LIST__).  RELOC is the relocation to use for an entry in
  251.      the set when generating a relocateable file, and is also used to
  252.      get the size of the entry when generating an executable file.
  253.      ABFD, SEC and VALUE identify the value to add to the set.  */
  254.   boolean (*add_to_set) PARAMS ((struct bfd_link_info *,
  255.                  struct bfd_link_hash_entry *entry,
  256.                  bfd_reloc_code_real_type reloc,
  257.                  bfd *abfd, asection *sec, bfd_vma value));
  258.   /* A function which is called when the name of a g++ constructor or
  259.      destructor is found.  This is only called by some object file
  260.      formats.  CONSTRUCTOR is true for a constructor, false for a
  261.      destructor.  This will use BFD_RELOC_CTOR when generating a
  262.      relocateable file.  NAME is the name of the symbol found.  ABFD,
  263.      SECTION and VALUE are the value of the symbol.  */
  264.   boolean (*constructor) PARAMS ((struct bfd_link_info *,
  265.                   boolean constructor,
  266.                   const char *name, bfd *abfd, asection *sec,
  267.                   bfd_vma value));
  268.   /* A function which is called when there is a reference to a warning
  269.      symbol.  WARNING is the warning to be issued.  */
  270.   boolean (*warning) PARAMS ((struct bfd_link_info *,
  271.                   const char *warning));
  272.   /* A function which is called when a relocation is attempted against
  273.      an undefined symbol.  NAME is the symbol which is undefined.
  274.      ABFD, SECTION and ADDRESS identify the location from which the
  275.      reference is made.  */
  276.   boolean (*undefined_symbol) PARAMS ((struct bfd_link_info *,
  277.                        const char *name, bfd *abfd,
  278.                        asection *section, bfd_vma address));
  279.   /* A function which is called when a reloc overflow occurs.  NAME is
  280.      the name of the symbol or section the reloc is against,
  281.      RELOC_NAME is the name of the relocation, and ADDEND is any
  282.      addend that is used.  ABFD, SECTION and ADDRESS identify the
  283.      location at which the overflow occurs; if this is the result of a
  284.      bfd_section_reloc_link_order or bfd_symbol_reloc_link_order, then
  285.      ABFD will be NULL.  */
  286.   boolean (*reloc_overflow) PARAMS ((struct bfd_link_info *,
  287.                      const char *name,
  288.                      const char *reloc_name, bfd_vma addend,
  289.                      bfd *abfd, asection *section,
  290.                      bfd_vma address));
  291.   /* A function which is called when a dangerous reloc is performed.
  292.      The canonical example is an a29k IHCONST reloc which does not
  293.      follow an IHIHALF reloc.  MESSAGE is an appropriate message.
  294.      ABFD, SECTION and ADDRESS identify the location at which the
  295.      problem occurred; if this is the result of a
  296.      bfd_section_reloc_link_order or bfd_symbol_reloc_link_order, then
  297.      ABFD will be NULL.  */
  298.   boolean (*reloc_dangerous) PARAMS ((struct bfd_link_info *,
  299.                       const char *message,
  300.                       bfd *abfd, asection *section,
  301.                       bfd_vma address));
  302.   /* A function which is called when a reloc is found to be attached
  303.      to a symbol which is not being written out.  NAME is the name of
  304.      the symbol.  ABFD, SECTION and ADDRESS identify the location of
  305.      the reloc; if this is the result of a
  306.      bfd_section_reloc_link_order or bfd_symbol_reloc_link_order, then
  307.      ABFD will be NULL.  */
  308.   boolean (*unattached_reloc) PARAMS ((struct bfd_link_info *,
  309.                        const char *name,
  310.                        bfd *abfd, asection *section,
  311.                        bfd_vma address));
  312.   /* A function which is called when a symbol in notice_hash is
  313.      defined or referenced.  NAME is the symbol.  ABFD, SECTION and
  314.      ADDRESS are the value of the symbol.  If SECTION is
  315.      bfd_und_section, this is a reference.  */
  316.   boolean (*notice) PARAMS ((struct bfd_link_info *, const char *name,
  317.                  bfd *abfd, asection *section, bfd_vma address));
  318. };
  319.  
  320. /* The linker builds link_order structures which tell the code how to
  321.    include input data in the output file.  */
  322.  
  323. /* These are the types of link_order structures.  */
  324.  
  325. enum bfd_link_order_type
  326. {
  327.   bfd_undefined_link_order,    /* Undefined.  */
  328.   bfd_indirect_link_order,    /* Built from a section.  */
  329.   bfd_fill_link_order,        /* Fill with a 16 bit constant.  */
  330.   bfd_data_link_order,        /* Set to explicit data.  */
  331.   bfd_section_reloc_link_order,    /* Relocate against a section.  */
  332.   bfd_symbol_reloc_link_order    /* Relocate against a symbol.  */
  333. };
  334.  
  335. /* This is the link_order structure itself.  These form a chain
  336.    attached to the section whose contents they are describing.  */
  337.  
  338. struct bfd_link_order 
  339. {
  340.   /* Next link_order in chain.  */
  341.   struct bfd_link_order *next;
  342.   /* Type of link_order.  */
  343.   enum bfd_link_order_type type;
  344.   /* Offset within output section.  */
  345.   bfd_vma offset;  
  346.   /* Size within output section.  */
  347.   bfd_size_type size;
  348.   /* Type specific information.  */
  349.   union 
  350.     {
  351.       struct 
  352.     {
  353.       /* Section to include.  If this is used, then
  354.          section->output_section must be the section the
  355.          link_order is attached to, section->output_offset must
  356.          equal the link_order offset field, and section->_raw_size
  357.          must equal the link_order size field.  Maybe these
  358.          restrictions should be relaxed someday.  */
  359.       asection *section;
  360.     } indirect;
  361.       struct
  362.     {
  363.       /* Value to fill with.  */
  364.       unsigned int value;
  365.     } fill;
  366.       struct
  367.     {
  368.       /* Data to put into file.  The size field gives the number
  369.          of bytes which this field points to.  */
  370.       bfd_byte *contents;
  371.     } data;
  372.       struct
  373.     {
  374.       /* Description of reloc to generate.  Used for
  375.          bfd_section_reloc_link_order and
  376.          bfd_symbol_reloc_link_order.  */
  377.       struct bfd_link_order_reloc *p;
  378.     } reloc;
  379.     } u;
  380. };
  381.  
  382. /* A linker order of type bfd_section_reloc_link_order or
  383.    bfd_symbol_reloc_link_order means to create a reloc against a
  384.    section or symbol, respectively.  This is used to implement -Ur to
  385.    generate relocs for the constructor tables.  The
  386.    bfd_link_order_reloc structure describes the reloc that BFD should
  387.    create.  It is similar to a arelent, but I didn't use arelent
  388.    because the linker does not know anything about most symbols, and
  389.    any asymbol structure it creates will be partially meaningless.
  390.    This information could logically be in the bfd_link_order struct,
  391.    but I didn't want to waste the space since these types of relocs
  392.    are relatively rare.  */
  393.  
  394. struct bfd_link_order_reloc
  395. {
  396.   /* Reloc type.  */
  397.   bfd_reloc_code_real_type reloc;
  398.  
  399.   union
  400.     {
  401.       /* For type bfd_section_reloc_link_order, this is the section
  402.      the reloc should be against.  This must be a section in the
  403.      output BFD, not any of the input BFDs.  */
  404.       asection *section;
  405.       /* For type bfd_symbol_reloc_link_order, this is the name of the
  406.      symbol the reloc should be against.  */
  407.       const char *name;
  408.     } u;
  409.  
  410.   /* Addend to use.  The object file should contain zero.  The BFD
  411.      backend is responsible for filling in the contents of the object
  412.      file correctly.  For some object file formats (e.g., COFF) the
  413.      addend must be stored into in the object file, and for some
  414.      (e.g., SPARC a.out) it is kept in the reloc.  */
  415.   bfd_vma addend;
  416. };
  417.  
  418. /* Allocate a new link_order for a section.  */
  419. extern struct bfd_link_order *bfd_new_link_order PARAMS ((bfd *, asection *));
  420.  
  421. #endif
  422.